home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / lisp / elk-2_0.lha / elk-2.0 / contrib / regexp / scm2doc.doc < prev    next >
Encoding:
Text File  |  1991-04-02  |  1.1 KB  |  33 lines
  1.                                   scm2doc.scm                                  
  2.  
  3.  Generate a documentation file from Scheme source.
  4.  Requires the Scheme file to be formatted in a particular way.
  5.  
  6.  All functions to be included in the documentation should have a comment
  7.  preceeding them containing a +f/-f around the section to appear in
  8.  the output.
  9.  
  10.  All misc. section to appear in the output should be contained within
  11.  +c/-c pairs.
  12.  
  13.  Note all comments must begin with `;;;' and the markers must appear
  14.  on their own line and flush left with the comment.
  15.  
  16.  System : ELK
  17.  System Specific Features :-
  18.    (error name string args ...)  ;; report an error
  19.    (require name)                ;; as in CommonLisp
  20.    (read-string port)            ;; read a line from a given port
  21.                                  ;; and return it
  22.  
  23.  
  24. scm2doc:comment-prefix
  25.  Set this to a string containing the comment style you prefer.
  26.  
  27. scm2doc:format-width
  28.  Define this to be the width of the output text.
  29.  Note currently that all this is used for is generating the title.
  30.  
  31. scm2doc:main infile outfile
  32.  Produce a documentation file `outfile' for the scheme file `infile'.
  33.